home *** CD-ROM | disk | FTP | other *** search
/ PC World 2006 July & August / PCWorld_2006-07-08_cd.bin / komunikace / apache / apache_2[1].2.2-win32-x86-no_ssl.msi / Data1.cab / _B8753E4705A85B355E768FA8B7815691 < prev    next >
Text File  |  2006-04-21  |  12KB  |  361 lines
  1. /* Copyright 2000-2005 The Apache Software Foundation or its licensors, as
  2.  * applicable.
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  *     http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Unless required by applicable law or agreed to in writing, software
  11.  * distributed under the License is distributed on an "AS IS" BASIS,
  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13.  * See the License for the specific language governing permissions and
  14.  * limitations under the License.
  15.  */
  16.  
  17. /* The purpose of this file is to store the code that MOST mpm's will need
  18.  * this does not mean a function only goes into this file if every MPM needs
  19.  * it.  It means that if a function is needed by more than one MPM, and
  20.  * future maintenance would be served by making the code common, then the
  21.  * function belongs here.
  22.  *
  23.  * This is going in src/main because it is not platform specific, it is
  24.  * specific to multi-process servers, but NOT to Unix.  Which is why it
  25.  * does not belong in src/os/unix
  26.  */
  27.  
  28. /**
  29.  * @file  mpm_common.h
  30.  * @brief Multi-Processing Modules functions
  31.  *
  32.  * @defgroup APACHE_MPM Multi-Processing Modules
  33.  * @ingroup  APACHE
  34.  * @{
  35.  */
  36.  
  37. #ifndef APACHE_MPM_COMMON_H
  38. #define APACHE_MPM_COMMON_H
  39.  
  40. #include "ap_config.h"
  41.  
  42. #if APR_HAVE_NETINET_TCP_H
  43. #include <netinet/tcp.h>    /* for TCP_NODELAY */
  44. #endif
  45.  
  46. #include "mpm.h"
  47.  
  48. #ifdef __cplusplus
  49. extern "C" {
  50. #endif
  51.  
  52. /* The maximum length of the queue of pending connections, as defined
  53.  * by listen(2).  Under some systems, it should be increased if you
  54.  * are experiencing a heavy TCP SYN flood attack.
  55.  *
  56.  * It defaults to 511 instead of 512 because some systems store it 
  57.  * as an 8-bit datatype; 512 truncated to 8-bits is 0, while 511 is 
  58.  * 255 when truncated.
  59.  */
  60. #ifndef DEFAULT_LISTENBACKLOG
  61. #define DEFAULT_LISTENBACKLOG 511
  62. #endif
  63.         
  64. /* Signal used to gracefully restart */
  65. #define AP_SIG_GRACEFUL SIGUSR1
  66.  
  67. /* Signal used to gracefully restart (without SIG prefix) */
  68. #define AP_SIG_GRACEFUL_SHORT USR1
  69.  
  70. /* Signal used to gracefully restart (as a quoted string) */
  71. #define AP_SIG_GRACEFUL_STRING "SIGUSR1"
  72.  
  73. /* Signal used to gracefully stop */
  74. #define AP_SIG_GRACEFUL_STOP SIGWINCH
  75.  
  76. /* Signal used to gracefully stop (without SIG prefix) */
  77. #define AP_SIG_GRACEFUL_STOP_SHORT WINCH
  78.  
  79. /* Signal used to gracefully stop (as a quoted string) */
  80. #define AP_SIG_GRACEFUL_STOP_STRING "SIGWINCH"
  81.  
  82. /**
  83.  * Make sure all child processes that have been spawned by the parent process
  84.  * have died.  This includes process registered as "other_children".
  85.  * @warning This is only defined if the MPM defines 
  86.  *          AP_MPM_WANT_RECLAIM_CHILD_PROCESSES
  87.  * @param terminate Either 1 or 0.  If 1, send the child processes SIGTERM
  88.  *        each time through the loop.  If 0, give the process time to die
  89.  *        on its own before signalling it.
  90.  * @tip This function requires that some macros are defined by the MPM: <pre>
  91.  *  MPM_CHILD_PID -- Get the pid from the specified spot in the scoreboard
  92.  *  MPM_NOTE_CHILD_KILLED -- Note the child died in the scoreboard
  93.  * </pre>
  94.  * @tip The MPM child processes which are reclaimed are those listed
  95.  * in the scoreboard as well as those currently registered via
  96.  * ap_register_extra_mpm_process().
  97.  */
  98. #ifdef AP_MPM_WANT_RECLAIM_CHILD_PROCESSES
  99. void ap_reclaim_child_processes(int terminate);
  100. #endif
  101.  
  102. /**
  103.  * Catch any child processes that have been spawned by the parent process
  104.  * which have exited. This includes processes registered as "other_children".
  105.  * @warning This is only defined if the MPM defines 
  106.  *          AP_MPM_WANT_RECLAIM_CHILD_PROCESSES
  107.  * @tip This function requires that some macros are defined by the MPM: <pre>
  108.  *  MPM_CHILD_PID -- Get the pid from the specified spot in the scoreboard
  109.  *  MPM_NOTE_CHILD_KILLED -- Note the child died in the scoreboard
  110.  * </pre>
  111.  * @tip The MPM child processes which are relieved are those listed
  112.  * in the scoreboard as well as those currently registered via
  113.  * ap_register_extra_mpm_process().
  114.  */
  115. #ifdef AP_MPM_WANT_RECLAIM_CHILD_PROCESSES
  116. void ap_relieve_child_processes(void);
  117. #endif
  118.  
  119. /**
  120.  * Tell ap_reclaim_child_processes() and ap_relieve_child_processes() about 
  121.  * an MPM child process which has no entry in the scoreboard.
  122.  * @warning This is only defined if the MPM defines
  123.  *          AP_MPM_WANT_RECLAIM_CHILD_PROCESSES
  124.  * @param pid The process id of an MPM child process which should be
  125.  * reclaimed when ap_reclaim_child_processes() is called.
  126.  * @tip If an extra MPM child process terminates prior to calling
  127.  * ap_reclaim_child_processes(), remove it from the list of such processes
  128.  * by calling ap_unregister_extra_mpm_process().
  129.  */
  130. #ifdef AP_MPM_WANT_RECLAIM_CHILD_PROCESSES
  131. void ap_register_extra_mpm_process(pid_t pid);
  132. #endif
  133.  
  134. /**
  135.  * Unregister an MPM child process which was previously registered by a
  136.  * call to ap_register_extra_mpm_process().
  137.  * @warning This is only defined if the MPM defines
  138.  *          AP_MPM_WANT_RECLAIM_CHILD_PROCESSES
  139.  * @param pid The process id of an MPM child process which no longer needs to
  140.  * be reclaimed.
  141.  * @return 1 if the process was found and removed, 0 otherwise
  142.  */
  143. #ifdef AP_MPM_WANT_RECLAIM_CHILD_PROCESSES
  144. int ap_unregister_extra_mpm_process(pid_t pid);
  145. #endif
  146.  
  147. /**
  148.  * Determine if any child process has died.  If no child process died, then
  149.  * this process sleeps for the amount of time specified by the MPM defined
  150.  * macro SCOREBOARD_MAINTENANCE_INTERVAL.
  151.  * @param status The return code if a process has died
  152.  * @param ret The process id of the process that died
  153.  * @param p The pool to allocate out of
  154.  */
  155. #ifdef AP_MPM_WANT_WAIT_OR_TIMEOUT
  156. void ap_wait_or_timeout(apr_exit_why_e *status, int *exitcode, apr_proc_t *ret, 
  157.                         apr_pool_t *p);
  158. #endif
  159.  
  160. /**
  161.  * Log why a child died to the error log, if the child died without the
  162.  * parent signalling it.
  163.  * @param pid The child that has died
  164.  * @param status The status returned from ap_wait_or_timeout
  165.  * @return 0 on success, APEXIT_CHILDFATAL if MPM should terminate
  166.  */
  167. #ifdef AP_MPM_WANT_PROCESS_CHILD_STATUS
  168. int ap_process_child_status(apr_proc_t *pid, apr_exit_why_e why, int status);
  169. #endif
  170.  
  171. #if defined(TCP_NODELAY) && !defined(MPE) && !defined(TPF)
  172. /**
  173.  * Turn off the nagle algorithm for the specified socket.  The nagle algorithm
  174.  * says that we should delay sending partial packets in the hopes of getting
  175.  * more data.  There are bad interactions between persistent connections and
  176.  * Nagle's algorithm that have severe performance penalties.
  177.  * @param s The socket to disable nagle for.
  178.  */
  179. void ap_sock_disable_nagle(apr_socket_t *s);
  180. #else
  181. #define ap_sock_disable_nagle(s)        /* NOOP */
  182. #endif
  183.  
  184. #ifdef HAVE_GETPWNAM
  185. /**
  186.  * Convert a username to a numeric ID
  187.  * @param name The name to convert
  188.  * @return The user id corresponding to a name
  189.  * @deffunc uid_t ap_uname2id(const char *name)
  190.  */
  191. AP_DECLARE(uid_t) ap_uname2id(const char *name);
  192. #endif
  193.  
  194. #ifdef HAVE_GETGRNAM
  195. /**
  196.  * Convert a group name to a numeric ID
  197.  * @param name The name to convert
  198.  * @return The group id corresponding to a name
  199.  * @deffunc gid_t ap_gname2id(const char *name)
  200.  */
  201. AP_DECLARE(gid_t) ap_gname2id(const char *name);
  202. #endif
  203.  
  204. #define AP_MPM_HARD_LIMITS_FILE APACHE_MPM_DIR "/mpm_default.h"
  205.  
  206. #ifdef AP_MPM_USES_POD
  207.  
  208. typedef struct ap_pod_t ap_pod_t;
  209.  
  210. struct ap_pod_t {
  211.     apr_file_t *pod_in;
  212.     apr_file_t *pod_out;
  213.     apr_pool_t *p;
  214. };
  215.  
  216. /**
  217.  * Open the pipe-of-death.  The pipe of death is used to tell all child
  218.  * processes that it is time to die gracefully.
  219.  * @param p The pool to use for allocating the pipe
  220.  */
  221. AP_DECLARE(apr_status_t) ap_mpm_pod_open(apr_pool_t *p, ap_pod_t **pod);
  222.  
  223. /**
  224.  * Check the pipe to determine if the process has been signalled to die.
  225.  */
  226. AP_DECLARE(apr_status_t) ap_mpm_pod_check(ap_pod_t *pod);
  227.  
  228. /**
  229.  * Close the pipe-of-death
  230.  */
  231. AP_DECLARE(apr_status_t) ap_mpm_pod_close(ap_pod_t *pod);
  232.  
  233. /**
  234.  * Write data to the pipe-of-death, signalling that one child process
  235.  * should die.
  236.  * @param p The pool to use when allocating any required structures.
  237.  */
  238. AP_DECLARE(apr_status_t) ap_mpm_pod_signal(ap_pod_t *pod);
  239.  
  240. /**
  241.  * Write data to the pipe-of-death, signalling that all child process
  242.  * should die.
  243.  * @param p The pool to use when allocating any required structures.
  244.  * @param num The number of child processes to kill
  245.  */
  246. AP_DECLARE(void) ap_mpm_pod_killpg(ap_pod_t *pod, int num);
  247. #endif
  248.  
  249. /*
  250.  * These data members are common to all mpms. Each new mpm
  251.  * should either use the appropriate ap_mpm_set_* function
  252.  * in their command table or create their own for custom or
  253.  * OS specific needs. These should work for most.
  254.  */
  255.  
  256. /**
  257.  * The maximum number of requests each child thread or
  258.  * process handles before dying off
  259.  */
  260. #ifdef AP_MPM_WANT_SET_MAX_REQUESTS
  261. extern int ap_max_requests_per_child;
  262. const char *ap_mpm_set_max_requests(cmd_parms *cmd, void *dummy,
  263.                                     const char *arg);
  264. #endif
  265.  
  266. /**
  267.  * The filename used to store the process id.
  268.  */
  269. #ifdef AP_MPM_WANT_SET_PIDFILE
  270. extern const char *ap_pid_fname;
  271. const char *ap_mpm_set_pidfile(cmd_parms *cmd, void *dummy,
  272.                                const char *arg);
  273. #endif
  274.  
  275. /**
  276.  * The name of lockfile used when Apache needs to lock the accept() call.
  277.  */
  278. #ifdef AP_MPM_WANT_SET_LOCKFILE
  279. extern const char *ap_lock_fname;
  280. const char *ap_mpm_set_lockfile(cmd_parms *cmd, void *dummy,
  281.                                 const char *arg);
  282. #endif
  283.  
  284. /**
  285.  * The system mutex implementation to use for the accept mutex.
  286.  */
  287. #ifdef AP_MPM_WANT_SET_ACCEPT_LOCK_MECH
  288. extern apr_lockmech_e ap_accept_lock_mech;
  289. extern const char ap_valid_accept_mutex_string[];
  290. const char *ap_mpm_set_accept_lock_mech(cmd_parms *cmd, void *dummy,
  291.                                         const char *arg);
  292. #endif
  293.  
  294. /*
  295.  * Set the scorboard file.
  296.  */
  297. #ifdef AP_MPM_WANT_SET_SCOREBOARD
  298. const char *ap_mpm_set_scoreboard(cmd_parms *cmd, void *dummy,
  299.                                   const char *arg);
  300. #endif
  301.  
  302. /*
  303.  * The directory that the server changes directory to dump core.
  304.  */
  305. #ifdef AP_MPM_WANT_SET_COREDUMPDIR
  306. extern char ap_coredump_dir[MAX_STRING_LEN];
  307. extern int ap_coredumpdir_configured;
  308. const char *ap_mpm_set_coredumpdir(cmd_parms *cmd, void *dummy,
  309.                                    const char *arg);
  310. #endif
  311.  
  312. /**
  313.  * Set the timeout period for a graceful shutdown.
  314.  */
  315. #ifdef AP_MPM_WANT_SET_GRACEFUL_SHUTDOWN
  316. extern int ap_graceful_shutdown_timeout;
  317. const char *ap_mpm_set_graceful_shutdown(cmd_parms *cmd, void *dummy,
  318.                                          const char *arg);
  319. #define AP_GRACEFUL_SHUTDOWN_TIMEOUT_COMMAND \
  320. AP_INIT_TAKE1("GracefulShutdownTimeout", ap_mpm_set_graceful_shutdown, NULL, \
  321.               RSRC_CONF, "Maximum time in seconds to wait for child "        \
  322.               "processes to complete transactions during shutdown")
  323. #endif
  324.  
  325.  
  326. #ifdef AP_MPM_WANT_SIGNAL_SERVER
  327. int ap_signal_server(int *, apr_pool_t *);
  328. void ap_mpm_rewrite_args(process_rec *);
  329. #endif
  330.  
  331. #ifdef AP_MPM_WANT_SET_MAX_MEM_FREE
  332. extern apr_uint32_t ap_max_mem_free;
  333. extern const char *ap_mpm_set_max_mem_free(cmd_parms *cmd, void *dummy,
  334.                                            const char *arg);
  335. #endif
  336.  
  337. #ifdef AP_MPM_WANT_SET_STACKSIZE
  338. extern apr_size_t ap_thread_stacksize;
  339. extern const char *ap_mpm_set_thread_stacksize(cmd_parms *cmd, void *dummy,
  340.                                                const char *arg);
  341. #endif
  342.  
  343. #ifdef AP_MPM_WANT_FATAL_SIGNAL_HANDLER
  344. extern apr_status_t ap_fatal_signal_setup(server_rec *s, apr_pool_t *pconf);
  345. extern apr_status_t ap_fatal_signal_child_setup(server_rec *s);
  346. #endif
  347.  
  348. #if AP_ENABLE_EXCEPTION_HOOK
  349. extern const char *ap_mpm_set_exception_hook(cmd_parms *cmd, void *dummy,
  350.                                              const char *arg);
  351. #endif
  352.  
  353. AP_DECLARE_HOOK(int,monitor,(apr_pool_t *p))
  354.  
  355. #ifdef __cplusplus
  356. }
  357. #endif
  358.  
  359. #endif /* !APACHE_MPM_COMMON_H */
  360. /** @} */
  361.